Warning revolt.js is currently being rewritten, it's pretty much ready for use for most applications but is still not entirely feature complete.
You can find the version 6 README here.
revolt.js is a JavaScript library for interacting with the entire Revolt API.
// esm / typescript
import { Client } from "revolt.js";
// ...or commonjs
const { Client } = require("revolt.js");
let client = new Client();
client.on("ready", async () =>
console.info(`Logged in as ${client.user.username}!`)
);
client.on("messageCreate", async (message) => {
if (message.content === "hello") {
message.channel.sendMessage("world");
}
});
client.loginBot("..");
All objects have reactivity built-in and can be dropped straight into any Solid.js project.
const client = new Client();
// initialise the client
function MyApp() {
return (
<h1>Your username is: {client.user?.username ?? "[logging in...]"}</h1>
);
}
All revolt-api types are re-exported from this library under API.
Warning It is advised you do not use this unless necessary, if you find somewhere that isn't covered by the library, please open an issue as this library aims to transform all objects.
import { API } from "revolt.js";
// API.Channel;
// API.[..];
Generated using TypeDoc
Generated using TypeDoc
Private authenticationPrivate baseURLGenerate authentication options.
Generate config to pass through to API.
Send HTTP DELETE request.
Typed Response Data
Path
Optional params: anyBody or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Send HTTP DELETE request.
Typed Response Data
Path
Optional params: anyBody or Query Parameters
Send HTTP GET request.
Typed Response Data
Path
Body or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Send HTTP GET request.
Typed Response Data
Path
Send HTTP PATCH request.
Typed Response Data
Path
Body or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Send HTTP PATCH request.
Typed Response Data
Path
Send HTTP POST request.
Typed Response Data
Path
Body or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Send HTTP POST request.
Typed Response Data
Path
Send HTTP PUT request.
Typed Response Data
Path
Body or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Send HTTP PUT request.
Typed Response Data
Path
Send any arbitrary request.
Typed Response Data
HTTP Method
Path
Body or Query Parameters
Optional config: AxiosRequestConfig<any>Axios configuration
Generated using TypeDoc
Bot Class
Construct Bot
Collection
Id
Private Readonly #collectionReadonly idWhether this bot has analytics enabled
Time when this user created their account
Whether this bot shows up on Discover
Interactions URL
Owner's Id
Link to privacy policy
Whether this bot can be invited by anyone
Link to terms of service
Bot Token
Edit a bot
Changes
Optional analytics?: null | booleanWhether analytics should be gathered for this bot
Must be enabled in order to show up on Revolt Discover.
Optional interactions_Interactions URL
Optional name?: null | stringBot username
Optional public?: null | booleanWhether the bot can be added by anyone
Optional remove?: null | ("Token" | "InteractionsURL")[]Fields to remove from bot object
Generated using TypeDoc
Collection of Bots
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Get or create
Bot
Id
Data
Bot Id
This equals the associated bot user's id.
Optional analytics?: booleanWhether to enable analytics
Optional discoverable?: booleanWhether this bot should be publicly discoverable
Optional flags?: null | numberFormat: int32
Enum of bot flags
Optional interactions_Reserved; URL for handling interactions
User Id of the bot owner
Optional privacy_URL for privacy policy
Whether the bot is public (may be invited by anyone)
Optional terms_URL for terms of service
Token used to authenticate requests for this bot
Generated using TypeDoc
Channel Class
Construct Channel
Collection
Channel Id
Private Optional #ackPrivate Optional #ackPrivate Readonly #collectionReadonly idWhether the conversation is active
URL to the animated channel icon
Time when this server was created
Default permissions for this server channel
Channel description
Display name
URL to the channel icon
Time when the last message was sent
ID of the last message sent in this channel
Whether this channel is marked as mature
Get mentions in this channel for user.
Channel name
Owner ID
Absolute pathname to this channel in the client
Permission the currently authenticated user has against this channel
Permissions allowed for users in this group
User ids of recipients of the group
Role permissions for this server channel
Server ID
URL to a small variant of the channel icon
Channel type
User ids of people currently typing in channel
Get whether this channel is unread.
Time when the channel was last updated (either created or a message was sent)
URL to this channel
User ID
Mark a channel as read
SavedMessages, DirectMessage, Group, TextChannel
Optional message: string | MessageLast read message or its ID
Optional skipRateLimiter: booleanWhether to skip the internal rate limiter
Create an invite to the channel
TextChannel, VoiceChannel
Newly created invite code
Edit a channel
Changes
Optional archived?: null | booleanWhether this channel is archived
Optional description?: null | stringChannel description
Optional icon?: null | stringIcon
Provide an Autumn attachment Id.
Optional name?: null | stringChannel name
Optional nsfw?: null | booleanWhether this channel is age-restricted
Optional owner?: null | stringGroup owner
Optional remove?: null | ("Description" | "Icon" | "DefaultPermissions")[]Fetch multiple messages from a channel
SavedMessages, DirectMessage, Group, TextChannel
Messages
Optional params: Omit<undefined | { Message fetching route data
Fetch multiple messages from a channel including the users that sent them
SavedMessages, DirectMessage, Group, TextChannel
Object including messages and users
Optional params: Omit<undefined | { Message fetching route data
Check whether we have a given permission in a channel
Whether we have this permission
Rest ...permission: ("Masquerade" | "Video" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]Permission Names
Check whether we have at least one of the given permissions in a channel
Whether we have one of the permissions
Rest ...permission: ("Masquerade" | "Video" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]Permission Names
Search for messages
SavedMessages, DirectMessage, Group, TextChannel
Messages
Message searching route data
Search for messages including the users that sent them
SavedMessages, DirectMessage, Group, TextChannel
Object including messages and users
Message searching route data
Send a message
SavedMessages, DirectMessage, Group, TextChannel
Sent message
Either the message as a string or message sending route data
Set role permissions
Group, TextChannel, VoiceChannel
Role Id, set to 'default' to affect all users
Permission value
Format: uint64
Allow bit flags
Format: uint64
Disallow bit flags
Generated using TypeDoc
Collection of Channels
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Get or create
Id
Data
Whether this object is new
Generated using TypeDoc
Channel Edit System Message
Construct System Message
Client
System Message
Readonly byProtected Optional clientReadonly typeStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Abstract Channel Invite
Construct Channel Invite
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Invite from an API Invite
Invite
Client
Data
Generated using TypeDoc
Channel Ownership Change System Message
Construct System Message
Client
System Message
Protected Optional clientReadonly fromReadonly toReadonly typeStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Channel Renamed System Message
Construct System Message
Client
System Message
Readonly byProtected Optional clientReadonly nameReadonly typeStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Channel Unread Class
Construct Channel
Collection
Channel Id
Private Readonly #collectionReadonly idLast read message id
List of message IDs that we were mentioned in
Generated using TypeDoc
Collection of Channel Unreads
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Iterable of key, value pairs in the map
Iterable
Filter the collection by a given predicate
Predicate to satisfy
Find some value based on a predicate
Predicate to satisfy
Execute a provided function over each key, value pair in the map
Iterable
Callback for each pair
Get an existing object
Object
Id
Get or create
Id
Data
Composite key pointing to a user's view of a channel
Channel Id
User Id
Optional last_Id of the last message read in this channel by a user
Optional mentions?: null | string[]Array of message ids that mention the user
Map the collection using a given callback
Callback
List of values in the map
List
Iterable of values in the map
Iterable
Generated using TypeDoc
Generic class collection backed by store
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Execute a provided function over each key, value pair in the map
Iterable
Callback for each pair
Generated using TypeDoc
Revolt.js Clients
Create Revolt.js Client
Optional options: Partial<ClientOptions>Optional configuration: { URL pointing to the client serving this node
Build information
Commit Hash
Commit Timestamp
Git Origin URL
Git Semver
Build Timestamp
Features enabled on this Revolt node
File server service configuration
Whether the service is enabled
URL pointing to the service
hCaptcha configuration
Whether captcha is enabled
Client key used for solving captcha
Whether email verification is enabled
Whether this server is invite only
Proxy service configuration
Whether the service is enabled
URL pointing to the service
Voice server configuration
Whether voice is enabled
URL pointing to the voice API
URL pointing to the voice WebSocket server
Revolt API Version
Web Push VAPID public key
WebSocket URL
Private #reconnectPrivate #sessionPrivate #setPrivate #setReadonly apiReadonly botsReadonly channelReadonly channelsReadonly connectionReadonly emojisReadonly eventsReadonly messagesReadonly optionsReadonly readyReadonly serverReadonly serversReadonly usersStatic prefixedPrivate #fetchPrivate #updateRest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]Optional context: anyLog in with auth data, creating a new session in the process.
An on-boarding function if on-boarding is required, undefined otherwise
Login data object
Optional fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]Optional context: anyOptional once: booleanAdd a listener for a given event.
Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]Optional context: anyAdd a one-time listener for a given event.
Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]Optional context: anyRegister for a new account
A promise containing a registration response object
Registration data object
Optional captcha?: null | stringCaptcha verification code
Valid email address
Optional invite?: null | stringInvite code
Password
Remove the listeners of a given event.
Optional fn: ((...args: ArgumentMap<Events>[Extract<T, keyof Events>]) => void)Rest ...args: ArgumentMap<Events>[Extract<T, keyof Events>]Optional context: anyOptional once: booleanGenerated using TypeDoc
Abstract Abstract Collection type
Abstract deleteAbstract entriesAbstract forExecute a provided function over each key, value pair in the map
Callback for each pair
Abstract getAbstract hasAbstract keysAbstract sizeAbstract valuesGenerated using TypeDoc
Emoji Class
Construct Emoji
Collection
Emoji Id
Private Readonly #collectionReadonly idWhether the emoji is animated
Time when this emoji was created
Whether the emoji is marked as mature
Name
Information about the parent of this emoji
Generated using TypeDoc
Collection of Emoji
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Get or create
Id
Data
Unique Id
Optional animated?: booleanWhether the emoji is animated
Uploader user id
Emoji name
Optional nsfw?: booleanWhether the emoji is marked as nsfw
What owns this emoji
Whether this object is new
Generated using TypeDoc
Simple wrapper around the Revolt websocket service.
Create a new event client.
Target protocol version
Communication format
Optional options: Partial<EventClientOptions>Configuration options
Private #heartbeatPrivate #pongPrivate #protocolPrivate #setPrivate #setPrivate #socketPrivate #transportReadonly optionsReadonly pingReadonly stateStatic prefixedRest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Optional context: anyCalls each of the listeners registered for a given event.
Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Return the listeners registered for a given event.
Optional fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Optional context: anyOptional once: booleanAdd a listener for a given event.
Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Optional context: anyAdd a one-time listener for a given event.
Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Optional context: anyRemove all listeners, or those of the specified event.
Optional event: keyof Events<T, EventProtocol<T>>Remove the listeners of a given event.
Optional fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]Optional context: anyOptional once: booleanPrivate setSet the current state
state
Generated using TypeDoc
Uploaded File
Construct File
Client
File
Unique Id
Raw content type of this file
Optional deleted?: null | booleanWhether this file was deleted
Original filename
Optional message_Parsed metadata of this file
Optional object_Id of the object this file is associated with
Optional reported?: null | booleanWhether this file was reported
Optional server_Format: int
Size of this file (in bytes)
Tag / bucket this file was uploaded to
Optional user_Private #clientReadonly contentRaw content type of this file
Readonly filenameOriginal filename
Readonly idFile Id
Readonly metadataParsed metadata of the file
Readonly sizeSize of the file (in bytes)
Readonly tagFile bucket
Download URL for the file
Human readable file size
Whether this file should have a spoiler
Direct URL to the file
Creates a URL to a given file with given options.
Generated URL or nothing
Optional options: { Optional query parameters to modify object
Optional height?: numberOptional max_Optional size?: numberOptional width?: numberOptional allowAnimation: booleanReturns GIF if applicable, no operations occur on image
Generated using TypeDoc
Image Embed
Construct Image Embed
Client
Embed
Protected Optional clientReadonly heightReadonly sizeReadonly typeReadonly urlReadonly widthProxied image URL
Static fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Message Class
Construct Message
Collection
Message Id
Private Readonly #collectionReadonly idGet the animated avatar URL for this message
Id of user this message was sent by
Get the avatar URL for this message
Id of channel this message was sent in
Content
Time when this message was posted
Time at which this message was edited
Embeds
Interactions
Masquerade
Avatar URL from the masquerade
Member this message was sent by
IDs of users this message mentions
Nonce value
Absolute pathname to this message in the client
Reactions
IDs of messages this message replies to
Get the role colour for this message
System message content
URL to this message
Get the username for this message
Edit a message
Message edit route data
Optional content?: null | stringNew message content
Optional embeds?: null | { Embeds to include in the message
Reply to Message
Generated using TypeDoc
Collection of Messages
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Get or create
Id
Data
Unique Id
Optional attachments?: null | { Array of attachments
Id of the user that sent this message
Id of the channel this message was sent in
Optional content?: null | stringMessage content
Optional edited?: null | stringTime at which this message was last edited
Optional embeds?: null | ({ Attached embeds to this message
Optional interactions?: { Information about how this message should be interacted with
Optional reactions?: null | string[]Reactions which should always appear and be distinct
Optional restrict_Whether reactions should be restricted to the given list
Can only be set to true if reactions list is of at least length 1
Optional masquerade?: null | { Name and / or avatar overrides for this message
Optional mentions?: null | string[]Array of user ids mentioned in this message
Optional nonce?: null | stringUnique value generated by client sending this message
Optional reactions?: { Hashmap of emoji IDs to array of user IDs
Optional replies?: null | string[]Array of message ids this message is replying to
Optional system?: null | { System message
Whether this object is new
Globally fetch messages
Admin
Message query
Generated using TypeDoc
Abstract Message Embed
Construct Embed
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Public Bot Class
Construct Public Bot
Client
Data
Bot Id
Optional avatar?: null | { Profile Avatar
Optional description?: null | stringProfile Description
Bot Username
Private #clientOptional Readonly avatarOptional Readonly descriptionReadonly idReadonly usernameGenerated using TypeDoc
Abstract Public Channel Invite
Construct Channel Invite
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Invite from an API Invite Response
Invite
Client
Data
Generated using TypeDoc
Server Class
Construct Server
Collection
Id
Private Readonly #collectionReadonly idWhether analytics are enabled for this server
URL to the server's animated icon
URL to the server's banner
Categories
Channel IDs
Time when this server was created
Default permissions
Description
Whether this server is publicly discoverable
Server flags
URL to the server's icon
Whether this server is marked as mature
Own member object for this server
Find all message IDs of unread messages
Array of message IDs which are unread
Name
Get an array of ordered categories with their respective channels.
Uncategorised channels are returned in id="default" category.
Get an ordered array of roles with their IDs attached. The highest ranking roles will be first followed by lower ranking roles. This is dictated by the "rank" property which is smaller for higher priority roles.
Owner's user ID
Permission the currently authenticated user has against this server
Roles
System message channels
Ban user from this server
User
Ban options
Optional reason?: null | stringBan reason
Create a channel
The newly-created channel
Channel create route data
Optional description?: null | stringChannel description
Channel name
Optional nsfw?: null | booleanWhether this channel is age restricted
Optional type?: "Text" | "Voice"Channel type
Text
Create an emoji on the server
Autumn Id
Options
Create role
Role name
Edit a server
Changes
Optional analytics?: null | booleanWhether analytics should be collected for this server
Must be enabled in order to show up on Revolt Discover.
Optional banner?: null | stringAttachment Id for banner
Optional categories?: null | { Category structure for server
Optional description?: null | stringServer description
Optional discoverable?: null | booleanWhether this server is public and should show up on Revolt Discover
Optional flags?: null | numberFormat: int32
Bitfield of server flags
Optional icon?: null | stringAttachment Id for icon
Optional name?: null | stringServer name
Optional remove?: null | ("Description" | "Icon" | "Categories" | "SystemMessages" | "Banner")[]Fields to remove from server object
Optional system_System message configuration
Edit a role
Role ID
Role editing route data
Optional colour?: null | stringRole colour
Optional hoist?: null | booleanWhether this role should be displayed separately
Optional name?: null | stringRole name
Optional rank?: null | numberFormat: int64
Ranking position
Smaller values take priority.
Optional remove?: null | "Colour"[]Fields to remove from role object
Fetch a server's invites
An array of the server's invites
Fetch a server member
Server member object
User
Fetch a server's members
List of the server's members and their user objects
Check whether we have a given permission in a server
Whether we have this permission
Rest ...permission: ("Masquerade" | "Video" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]Permission Names
Kick user from this server
User
Check whether we have at least one of the given permissions in a server
Whether we have one of the permissions
Rest ...permission: ("Masquerade" | "Video" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]Permission Names
Set role permissions
Role Id, set to 'default' to affect all users
Permission value
Generated using TypeDoc
Server Ban
Construct Server Ban
Client
Data
Unique member id
Server Id
User Id
Optional reason?: null | stringReason for ban creation
Protected clientReadonly idServer Id
User Id
Optional Readonly reasonGenerated using TypeDoc
Collection of Servers
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Create a server
The newly-created server
Server options
Optional description?: null | stringServer description
Server name
Optional nsfw?: null | booleanWhether this server is age-restricted
Get or create
Id
Data
Unique Id
Optional analytics?: booleanWhether to enable analytics
Optional banner?: null | { Banner attachment
Optional categories?: null | { Categories for this server
Channels within this server
Format: int64
Default set of server and channel permissions
Optional description?: null | stringDescription for the server
Optional discoverable?: booleanWhether this server should be publicly discoverable
Optional flags?: null | numberFormat: int32
Bitfield of server flags
Optional icon?: null | { Icon attachment
Name of the server
Optional nsfw?: booleanWhether this server is flagged as not safe for work
User id of the owner
Optional roles?: { Roles for this server
Optional system_Configuration for sending system event messages
Whether this object is new
Generated using TypeDoc
Server Invite
Construct Server Invite
Client
Invite
Readonly channelProtected Optional clientReadonly creatorReadonly idReadonly serverReadonly typeStatic fromCreate an Invite from an API Invite
Invite
Client
Data
Generated using TypeDoc
Server Member Class
Construct Server Member
Collection
Id
Server Id
User Id
Private Readonly #collectionReadonly idServer Id
User Id
URL to the member's animated avatar
URL to the member's avatar
Member's currently hoisted role.
When this user joined the server
Nickname
Ordered list of roles for this member, from lowest to highest priority.
Member's ranking Smaller values are ranked as higher priority
Member's current role colour.
List of role IDs
Time at which timeout expires
Edit a member
Changes
Optional avatar?: null | stringAttachment Id to set for avatar
Optional nickname?: null | stringMember nickname
Optional remove?: null | ("Nickname" | "Avatar" | "Roles" | "Timeout")[]Fields to remove from channel object
Optional roles?: null | string[]Array of role ids
Optional timeout?: null | stringTimestamp this member is timed out until
Check whether a member has a certain permission against a certain object
Whether the member has this permission
Target object to check permissions against
Rest ...permission: ("Masquerade" | "Video" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]Permission names to check for
Checks whether the target member has a higher rank than this member.
Whether this member is inferior to the target
The member to compare against
Generated using TypeDoc
Collection of Server Members
Create generic class collection
Client
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Iterable of key, value pairs in the map
Iterable
Fetch server member by Id
Message
Server Id
User Id
Filter the collection by a given predicate
Predicate to satisfy
Find some value based on a predicate
Predicate to satisfy
Execute a provided function over each key, value pair in the map
Iterable
Callback for each pair
Get an existing object
Object
Id
Get member by composite key
Member
Id
Server Id
User Id
Get or create
Id
Server Id
User Id
Data
Unique member id
Server Id
User Id
Optional avatar?: null | { Avatar attachment
Time at which this user joined the server
Optional nickname?: null | stringMember's nickname
Optional roles?: string[]Member's roles
Optional timeout?: null | stringTimestamp this member is timed out until
Get or return partial
Id
Server Id
User Id
Map the collection using a given callback
Callback
List of values in the map
List
Iterable of values in the map
Iterable
Generated using TypeDoc
Public Server Invite
Construct Server Invite
Client
Invite
Optional Readonly channelReadonly channelReadonly channelProtected Optional clientReadonly codeReadonly memberOptional Readonly serverReadonly serverOptional Readonly serverReadonly serverReadonly serverReadonly typeOptional Readonly userReadonly userStatic fromCreate an Invite from an API Invite Response
Invite
Client
Data
Generated using TypeDoc
Abstract Collection backed by a Solid.js Store
Construct store backed collection
Private #objectsPrivate #storageReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Execute a provided function over each key, value pair in the map
Iterable
Callback for each pair
Generated using TypeDoc
Abstract System Message
Construct System Message
Client
Type
Protected Optional clientReadonly typeStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Text Embed
Protected Optional clientOptional Readonly colourOptional Readonly descriptionOptional Readonly iconOptional Readonly mediaOptional Readonly titleReadonly typeOptional Readonly urlProxied icon URL
Static fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Text System Message
Construct System Message
Client
System Message
Protected Optional clientReadonly contentReadonly typeStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Embed of unknown type
Construct Embed
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Invite of unknown type
Construct Channel Invite
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Invite from an API Invite
Invite
Client
Data
Generated using TypeDoc
Public invite of unknown type
Construct Channel Invite
Optional client: ClientClient
Type
Protected Optional clientReadonly typeStatic fromCreate an Invite from an API Invite Response
Invite
Client
Data
Generated using TypeDoc
User Class
Construct User
Collection
Id
Private Readonly #collectionReadonly idURL to the user's animated avatar
URL to the user's avatar
Badges
Bot information
Time when this user created their account
URL to the user's default avatar
Whether the user is online
Permissions against this user
Whether the user is privileged
Relationship with user
User Status
Username
Change the username of the current user
New username
Current password
Edit the user
Changes
Optional avatar?: null | stringAttachment Id for avatar
Optional badges?: null | numberFormat: int32
Bitfield of user badges
Optional flags?: null | numberFormat: int32
Enum of user flags
Optional profile?: null | { New user profile data
This is applied as a partial.
Optional remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground")[]Fields to remove from user object
Optional status?: null | { New user status
Fetch the profile of a user
The profile of the user
Generated using TypeDoc
Collection of Users
Construct User collection
Private #objectsPrivate #storageReadonly clientReadonly getReadonly updateCreate a new instance of an object
Id
Type
Instance
Context
Optional data: unknownData
Get or create
Id
Data
Unique Id
Optional avatar?: null | { Avatar attachment
Optional badges?: null | numberFormat: int32
Bitfield of user badges
Optional bot?: null | { Bot information
Optional flags?: null | numberFormat: int32
Enum of user flags
Optional online?: null | booleanWhether this user is currently online
Optional privileged?: booleanWhether this user is privileged
Optional profile?: null | { User's profile page
Optional relations?: null | { Relationships with other users
Optional relationship?: null | "User" | "None" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"Current session user's relationship with this user
Optional status?: null | { User's current status
Username
Generated using TypeDoc
User Moderated System Message
Construct System Message
Client
System Message
Readonly byProtected Optional clientReadonly typeReadonly userStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
User System Message
Construct System Message
Client
System Message
Protected Optional clientReadonly typeReadonly userStatic fromCreate an System Message from an API System Message
System Message
Client
Generated using TypeDoc
Video Embed
Construct Video Embed
Client
Embed
Protected Optional clientReadonly heightReadonly typeReadonly urlReadonly widthProxied video URL
Static fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Website Embed
Construct Video Embed
Client
Embed
Protected Optional clientOptional Readonly colourOptional Readonly descriptionOptional Readonly iconOptional Readonly imageOptional Readonly originalOptional Readonly siteOptional Readonly specialOptional Readonly titleReadonly typeOptional Readonly urlOptional Readonly videoIf special content is present, generate the embed URL
Proxied icon URL
Static fromCreate an Embed from an API Embed
Embed
Client
Data
Generated using TypeDoc
Flags attributed to users
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Badges available to users
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Client configuration options
Authentication used for requests
Optional rauth?: stringOptional revolt?: string | { Base URL of the Revolt node
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Client options object
Generated using TypeDoc
Generated using TypeDoc
Const Regular expression for channels.
Generated using TypeDoc
Const Regular expression for mentions.
Generated using TypeDoc
Const Regular expression for spoilers.
Generated using TypeDoc
API Client